Add type information to Socket.data
#4159
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
backmeupplz
changed the title
socket.dataSocket.data
Contributor
Author
|
I'm also not sure if I missed any spots where the types should be added. Maybe @MaximeKjaer could take a look? |
Member
|
@backmeupplz awesome, thanks a lot 👍 |
dzad
pushed a commit
to dzad/socket.io
that referenced
this pull request
May 29, 2023
Usage:
```js
interface SocketData {
name: string;
age: number;
}
const io = new Server<ClientToServerEvents, ServerToClientEvents, InterServerEvents, SocketData>();
io.on("connection", (socket) => {
socket.data.name = "john";
socket.data.age = 42;
});
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The kind of change this PR does introduce
Current behavior
Socket.dataisanyNew behavior
Socket.dataisanyby default butPartial<ProvidedType>if a type is provided in theServerand/orSocketconstructorsOther information (e.g. related issues)
I had to wrap the provided type in
Partialbecause we are initializing theSocket.datawith{}. I did not want to alter this behavior but instead I just wanted to provide a simple way to type theSocket.datafield. This fixes #4155.